Apple WWDC 1996/WWDC96_1996 (CD).toast/Technology Materials/MacApp Release 10/MacApp Release 10 - HD Ready/Libraries/Framework/Includes/UAdorners.h

Text File | 1996-04-03 | 28.4 KB | 889 lines | [TEXT/MPS ]

// UAdorners.h
// Copyright © 1984-96 by Apple Computer, Inc. All rights reserved.

#ifndef __UADORNERS__
#define __UADORNERS__

// MacApp

#ifndef __TOOLBOX__
#include "Toolbox.h"
#endif

#ifndef __UDYNAMICARRAY__
#include "UDynamicArray.h"
#endif

#ifndef __UGEOMETRY__
#include "UGeometry.h"
#endif

#ifndef __ULISTITERATOR__
#include "UListIterator.h"
#endif


//----------------------------------------------------------------------------------------
// Forward and external class declarations.
//----------------------------------------------------------------------------------------

class TAdorner;
class TAdornerList;
class TView;


//----------------------------------------------------------------------------------------
// Constants used to indicate adorner priorities
//----------------------------------------------------------------------------------------

const short kAdornLast = 127;
    // Low priority adorners are considered last

const short kAdornAfter = kAdornLast - 32;
    // Low priority adorners are considered last

const short kDrawView = 64;
    // View priority is special case

const short kAdornBefore = kDrawView - 32;
    // High priority adorners take precedence

const short kAdornFirst = 0;
    // High priority adorners take precedence


//----------------------------------------------------------------------------------------
// Constants for indicating whether an adorner should be freed.  TAdorner::RemovedFromView
// tests fFreeOnDeletion to see if the object should free itself.
//----------------------------------------------------------------------------------------

const Boolean kFreeOnDeletion = TRUE;

const Boolean kDontFreeOnDeletion = !kFreeOnDeletion;


//----------------------------------------------------------------------------------------
// Constant signatures for some default adorners.
//----------------------------------------------------------------------------------------

const IDType kDimAdorner        = 'dima';
const IDType kDrawAdorner        = 'draw';
const IDType kEraseAdorner        = 'eras';
const IDType kFrameAdorner        = 'fram';
const IDType kHiliteAdorner        = 'hili';
const IDType kLineBottomAdorner = 'lnbo';
const IDType kLineLeftAdorner    = 'lnlf';
const IDType kLineRightAdorner    = 'lnrt';
const IDType kLineTopAdorner    = 'lntp';
const IDType kOvalAdorner        = 'oval';
const IDType kPrintAdorner        = 'prnt';
const IDType kResizeIconAdorner = 'resz';
const IDType kRRectAdorner        = 'rrct';
const IDType kSelectionAdorner    = 'sele';
const IDType kShadowedFrameAdorner    = 'sfra';
const IDType kCompatibilityAdorner    = 'comp';


//----------------------------------------------------------------------------------------
// Typedefs
//----------------------------------------------------------------------------------------

typedef char AdornPriority;


//----------------------------------------------------------------------------------------
// CAdornerIterator
//----------------------------------------------------------------------------------------

class CAdornerIterator : public CArrayIterator
{
public:
    CAdornerIterator(const TView* theView,
                       ArrayIndex itsLowBound, ArrayIndex itsHighBound,
                       Boolean itsForward);

    CAdornerIterator(const TView* theView, Boolean itsForward);

    CAdornerIterator(const TView* theView);

    CAdornerIterator(TAdornerList* theAdornerList);

    virtual ~CAdornerIterator();

    TAdorner* CurrentAdorner();
        // returns the current adorner

    TAdorner* FirstAdorner();
        // Reset the iteration and return the first adorner in the iteration

    TAdorner* NextAdorner();
        // advances the iteration and then returns the adorner
};


//----------------------------------------------------------------------------------------
// TAdorner: abstract superclass for adorners which are basically  rendering algorithms
//----------------------------------------------------------------------------------------

class TAdorner : public TObject
{
    MA_DECLARE_CLASS;

public:
    //------------------------------------------------------------------------------------
    // constructor and destructor
    //------------------------------------------------------------------------------------

    TAdorner();

    virtual ~TAdorner();
        // Destructor

    void IAdorner(IDType itsID, Boolean freeOnDeletion);
        // initializes the adorner

    //------------------------------------------------------------------------------------
    // notification
    //------------------------------------------------------------------------------------

    virtual void AddedToView(TView* itsView);
        // Notification that this adorner has been added to a view

    virtual void RemovedFromView(TView* itsView);
        // Notification that this adorner has been removed from a view


    //------------------------------------------------------------------------------------
    // Stream I/O protocol support.
    //------------------------------------------------------------------------------------

    virtual void ReadFrom(TStream* aStream);    // Override

    virtual void WriteTo(TStream* aStream);    // Override


    //------------------------------------------------------------------------------------
    // rendering
    //------------------------------------------------------------------------------------

    virtual void Draw(TView* itsView, const VRect& area);

    virtual void DrawLine(VHSelect vhs, short lh, short lv, short lto);
        // Utility routine for adorners - draws a line.

    virtual void DoHighlightSelection(TView* itsView,
                                             const VRect& area,
                                             HLState fromHL,
                                             HLState toHL);
        // Adorns the selection before the view's DoHighlightSelection.

    virtual void InvalidateAdorner(TView* itsView);
        // Invalidates the adorner in itsView.

    virtual void ViewChangedFrame (TView* itsView,
                                            const VRect& oldFrame,
                                            const VRect& newFrame,
                                            Boolean    invalidate);
        // This method is called when the owning view changes size

    virtual Boolean DoesAdorn (TView* itsView);
        // Default returns true. The adornment only includes enabled adorners
        // in its iteration.

    //------------------------------------------------------------------------------------
    // data members
    //------------------------------------------------------------------------------------
public:
    IDType fIdentifier;                                    // The ID of this adorner, to distinguish
                                                // it from other instances.

    Boolean fFreeOnDeletion;                    // Should the adorner be freed when
                                                // removed from an adornment
};


//----------------------------------------------------------------------------------------
// TCompatibilityAdorner: Draws the adornment available in MacApp 2.0.
//----------------------------------------------------------------------------------------

class TCompatibilityAdorner : public TAdorner
{
    MA_DECLARE_CLASS;

public:
    TCompatibilityAdorner();

    virtual ~TCompatibilityAdorner();
        // Destructor

    void ICompatibilityAdorner(CntlAdornment itsAdornment);

    //------------------------------------------------------------------------------------
    // Standard signature support.
    //------------------------------------------------------------------------------------

    virtual IDType GetStandardSignature();    // Override
        // Returns this class's standard signature.

    //------------------------------------------------------------------------------------
    // Stream I/O protocol support.
    //------------------------------------------------------------------------------------

    virtual void ReadFrom(TStream* aStream);    // Override

    virtual void WriteTo(TStream* aStream);    // Override

    //------------------------------------------------------------------------------------
    // rendering
    //------------------------------------------------------------------------------------

    virtual void Draw(TView* itsView, const VRect& area);    // Override

    //------------------------------------------------------------------------------------
    // data members
    //------------------------------------------------------------------------------------
public:
    CntlAdornment fAdornment;
};

//----------------------------------------------------------------------------------------
// TDimAdorner
//----------------------------------------------------------------------------------------

class TDimAdorner : public TAdorner
{
    MA_DECLARE_CLASS;

public:
    TDimAdorner();
    virtual ~TDimAdorner();
        // Destructor

    inline void IDimAdorner()
    { IAdorner(kDimAdorner,kDontFreeOnDeletion); }
        // Initializes this adorner with ID kDimAdorner and fFreeOnDeletion false

    //------------------------------------------------------------------------------------
    // Standard signature support.
    //------------------------------------------------------------------------------------

    virtual IDType GetStandardSignature();    // Override
        // Returns this class's standard signature.

    //------------------------------------------------------------------------------------
    // rendering
    //------------------------------------------------------------------------------------

    virtual void Draw(TView* itsView, const VRect& area);    // Override
        // calls itsView->Dim
};


//----------------------------------------------------------------------------------------
// TDrawAdorner
//----------------------------------------------------------------------------------------

class TDrawAdorner : public TAdorner
{
    MA_DECLARE_CLASS;

public:
    TDrawAdorner();
    virtual ~TDrawAdorner();
        // Destructor

    inline void IDrawAdorner()
    { IAdorner(kDrawAdorner,kDontFreeOnDeletion); }
        // Initializes this adorner with ID kDrawAdorner and fFreeOnDeletion false

    //------------------------------------------------------------------------------------
    // Standard signature support.
    //------------------------------------------------------------------------------------

    virtual IDType GetStandardSignature();    // Override
        // Returns this class's standard signature.

    //------------------------------------------------------------------------------------
    // rendering
    //------------------------------------------------------------------------------------

    virtual void Draw(TView* itsView, const VRect& area);    // Override
        // calls itsView->Draw(area)
};


//----------------------------------------------------------------------------------------
// TEraseAdorner
//----------------------------------------------------------------------------------------

class TEraseAdorner : public TAdorner
{
    MA_DECLARE_CLASS;

public:
    TEraseAdorner();
    virtual ~TEraseAdorner();
        // Destructor

    inline void IEraseAdorner()
    { IAdorner(kEraseAdorner,kDontFreeOnDeletion); }
        // Initializes this adorner with ID kEraseAdorner and fFreeOnDeletion false

    //------------------------------------------------------------------------------------
    // Standard signature support.
    //------------------------------------------------------------------------------------

    virtual IDType GetStandardSignature();    // Override
        // Returns this class's standard signature.

    //------------------------------------------------------------------------------------
    // rendering
    //------------------------------------------------------------------------------------

    virtual void Draw(TView* itsView, const VRect& area);    // Override
        // calls itsView->Draw(area)
};


//----------------------------------------------------------------------------------------
// THiliteAdorner
//----------------------------------------------------------------------------------------

class THiliteAdorner : public TAdorner
{
    MA_DECLARE_CLASS;

public:
    THiliteAdorner();
    virtual ~THiliteAdorner();
        // Destructor

    inline void IHiliteAdorner()
    { IAdorner(kHiliteAdorner,kDontFreeOnDeletion); }
        //  Initializes this adorner with ID kHiliteAdorner and fFreeOnDeletion false

    //------------------------------------------------------------------------------------
    // Standard signature support.
    //------------------------------------------------------------------------------------

    virtual IDType GetStandardSignature();    // Override
        // Returns this class's standard signature.

    //------------------------------------------------------------------------------------
    // rendering
    //------------------------------------------------------------------------------------

    virtual void Draw(TView* itsView, const VRect& area);    // Override
        //  calls itsView->Hilite
};


//----------------------------------------------------------------------------------------
// TPrintAdorner
//----------------------------------------------------------------------------------------

class TPrintAdorner : public TAdorner
{
    MA_DECLARE_CLASS;

public:
    TPrintAdorner();
    virtual ~TPrintAdorner();
        // Destructor

    inline void IPrintAdorner()
    { IAdorner(kPrintAdorner,kDontFreeOnDeletion); }
        // Initializes this adorner with ID kPrintAdorner and fFreeOnDeletion false

    //------------------------------------------------------------------------------------
    // Standard signature support.
    //------------------------------------------------------------------------------------

    virtual IDType GetStandardSignature();    // Override
        // Returns this class's standard signature.

    //------------------------------------------------------------------------------------
    // rendering
    //------------------------------------------------------------------------------------

    virtual void DoHighlightSelection(TView* itsView,
                                             const VRect& area,
                                             HLState fromHL,
                                             HLState toHL);    // Override
        // calls itsView->DoHighlightSelection(fromHL, toHL)
};


//----------------------------------------------------------------------------------------
// TResizeIconAdorner
//----------------------------------------------------------------------------------------

class TResizeIconAdorner : public TAdorner
{
    MA_DECLARE_CLASS;

public:
    TResizeIconAdorner();
    virtual ~TResizeIconAdorner();
        // Destructor

    inline void IResizeIconAdorner()
    { IAdorner(kResizeIconAdorner,kDontFreeOnDeletion); }
        // Initializes this adorner with ID kResizeIconAdorner and fFreeOnDeletion false

    //------------------------------------------------------------------------------------
    // Standard signature support.
    //------------------------------------------------------------------------------------

    virtual IDType GetStandardSignature();    // Overridee
        // Returns this class's standard signature.

    //------------------------------------------------------------------------------------
    // rendering
    //------------------------------------------------------------------------------------

    virtual void DoHighlightSelection(TView* itsView,
                                             const VRect& area,
                                             HLState fromHL,
                                             HLState toHL);    // Override
        // calls ((TWindow*)itsView)->DrawResizeIcon
};


//----------------------------------------------------------------------------------------
// TSelectionAdorner
//----------------------------------------------------------------------------------------

class TSelectionAdorner : public TAdorner
{
    MA_DECLARE_CLASS;

public:
    TSelectionAdorner();
    virtual ~TSelectionAdorner();
        // Destructor

    inline void ISelectionAdorner()
    { IAdorner(kSelectionAdorner,kDontFreeOnDeletion); }
        //  Initializes this adorner with ID kSelectionAdorner and fFreeOnDeletion false

    //------------------------------------------------------------------------------------
    // Standard signature support.
    //------------------------------------------------------------------------------------

    virtual IDType GetStandardSignature();    // Override
        // Returns this class's standard signature.

    //------------------------------------------------------------------------------------
    // rendering
    //------------------------------------------------------------------------------------

    virtual void DoHighlightSelection(TView* itsView,
                                             const VRect& area,
                                             HLState fromHL,
                                             HLState toHL);    // Override
        //  calls itsView->DoHighlightSelection(fromHL, toHL)
};


//----------------------------------------------------------------------------------------
// TFrameAdorner
//----------------------------------------------------------------------------------------

class TFrameAdorner : public TAdorner
{
    MA_DECLARE_CLASS;

public:
    inline TFrameAdorner()
    {}

    virtual ~TFrameAdorner();
        // Destructor

    inline void IFrameAdorner(IDType itsID, Boolean freeOnDeletion)
    { IAdorner(itsID,freeOnDeletion); }
        // initializes this adorner with itsView

    //------------------------------------------------------------------------------------
    // Standard signature support.
    //------------------------------------------------------------------------------------

    virtual IDType GetStandardSignature();    // Override
        // Returns this class's standard signature.

    //------------------------------------------------------------------------------------
    // rendering
    //------------------------------------------------------------------------------------

    virtual void Draw(TView* itsView, const VRect& area);    // Override
        // frames the extent of itsView
};

//----------------------------------------------------------------------------------------
// TShadowedFrameAdorner
//----------------------------------------------------------------------------------------

class TShadowedFrameAdorner : public TAdorner
{
    MA_DECLARE_CLASS;

public:
    inline TShadowedFrameAdorner()
    { }

    virtual ~TShadowedFrameAdorner();
        // Destructor

    inline void IShadowedFrameAdorner(IDType itsID, Boolean freeOnDeletion)
    { IAdorner(itsID,freeOnDeletion); }
        // initializes this adorner with itsView

    //------------------------------------------------------------------------------------
    // Standard signature support.
    //------------------------------------------------------------------------------------

    virtual IDType GetStandardSignature();    // Override
        // Returns this class's standard signature.

    //------------------------------------------------------------------------------------
    // rendering
    //------------------------------------------------------------------------------------

    virtual void Draw(TView* itsView, const VRect& area);    // Override
        // frames the extent of itsView
};

//----------------------------------------------------------------------------------------
// TLineBottomAdorner
//----------------------------------------------------------------------------------------

class TLineBottomAdorner : public TAdorner
{
    MA_DECLARE_CLASS;

public:
    inline TLineBottomAdorner()
    { }

    virtual ~TLineBottomAdorner();
        // Destructor

    inline void ILineBottomAdorner(IDType itsID, Boolean freeOnDeletion)
    { IAdorner(itsID,freeOnDeletion); }
        // initializes this adorner with itsView

    //------------------------------------------------------------------------------------
    // Standard signature support.
    //------------------------------------------------------------------------------------

    virtual IDType GetStandardSignature();    // Override
        // Returns this class's standard signature.

    //------------------------------------------------------------------------------------
    // rendering
    //------------------------------------------------------------------------------------

    virtual void Draw(TView* itsView, const VRect& area);    // Override
        // draws bottom line
};


//----------------------------------------------------------------------------------------
// TLineLeftAdorner
//----------------------------------------------------------------------------------------

class TLineLeftAdorner : public TAdorner
{
    MA_DECLARE_CLASS;

public:
    inline TLineLeftAdorner()
    { }

    virtual ~TLineLeftAdorner();
        // Destructor

    inline void ILineLeftAdorner(IDType itsID, Boolean freeOnDeletion)
    { IAdorner(itsID,freeOnDeletion); }
        // initializes this adorner with itsView

    //------------------------------------------------------------------------------------
    // Standard signature support.
    //------------------------------------------------------------------------------------

    virtual IDType GetStandardSignature();    // Override
        // Returns this class's standard signature.

    //------------------------------------------------------------------------------------
    // rendering
    //------------------------------------------------------------------------------------

    virtual void Draw(TView* itsView, const VRect& area);    // Override
        // draws left line
};


//----------------------------------------------------------------------------------------
// TLineRightAdorner
//----------------------------------------------------------------------------------------

class TLineRightAdorner : public TAdorner
{
    MA_DECLARE_CLASS;

public:
    inline TLineRightAdorner()
    { }

    virtual ~TLineRightAdorner();
        // Destructor

    inline void ILineRightAdorner(IDType itsID, Boolean freeOnDeletion)
    { IAdorner(itsID,freeOnDeletion); }
        // initializes this adorner with itsView

    //------------------------------------------------------------------------------------
    // Standard signature support.
    //------------------------------------------------------------------------------------

    virtual IDType GetStandardSignature();    // Override
        // Returns this class's standard signature.

    //------------------------------------------------------------------------------------
    // rendering
    //------------------------------------------------------------------------------------

    virtual void Draw(TView* itsView, const VRect& area);    // Override
        // draws right line
};


//----------------------------------------------------------------------------------------
// TLineTopAdorner
//----------------------------------------------------------------------------------------

class TLineTopAdorner : public TAdorner
{
    MA_DECLARE_CLASS;

public:
    inline TLineTopAdorner()
    { }

    virtual ~TLineTopAdorner();
        // Destructor

    inline void ILineTopAdorner(IDType itsID, Boolean freeOnDeletion)
    { IAdorner(itsID,freeOnDeletion); }
        // initializes this adorner with itsView

    //------------------------------------------------------------------------------------
    // Standard signature support.
    //------------------------------------------------------------------------------------

    virtual IDType GetStandardSignature();    // Override
        // Returns this class's standard signature.

    //------------------------------------------------------------------------------------
    // rendering
    //------------------------------------------------------------------------------------

    virtual void Draw(TView* itsView, const VRect& area);    // Override
        // draws top line
};


//----------------------------------------------------------------------------------------
// TOvalAdorner
//----------------------------------------------------------------------------------------

class TOvalAdorner : public TAdorner
{
    MA_DECLARE_CLASS;

public:
    inline TOvalAdorner()
    { }

    virtual ~TOvalAdorner();
        // Destructor

    inline void IOvalAdorner(IDType itsID, Boolean freeOnDeletion)
    { IAdorner(itsID,freeOnDeletion); }
        // initializes this adorner with itsView

    //------------------------------------------------------------------------------------
    // Standard signature support.
    //------------------------------------------------------------------------------------

    virtual IDType GetStandardSignature();    // Override
        // Returns this class's standard signature.

    //------------------------------------------------------------------------------------
    // rendering
    //------------------------------------------------------------------------------------

    virtual void Draw(TView* itsView, const VRect& area);    // Override
        // draws oval adorner
};


//----------------------------------------------------------------------------------------
// TRRectAdorner
//----------------------------------------------------------------------------------------

class TRRectAdorner : public TAdorner
{
    MA_DECLARE_CLASS;

public:
    inline TRRectAdorner()
    { }

    virtual ~TRRectAdorner();
        // Destructor

    inline void IRRectAdorner(IDType itsID, Boolean freeOnDeletion)
    { IAdorner(itsID,freeOnDeletion); }
        // initializes this adorner with itsView

    //------------------------------------------------------------------------------------
    // Standard signature support.
    //------------------------------------------------------------------------------------

    virtual IDType GetStandardSignature();    // Override
        // Returns this class's standard signature.

    //------------------------------------------------------------------------------------
    // rendering
    //------------------------------------------------------------------------------------

    virtual void Draw(TView* itsView, const VRect& area);    // Override
        // adorns itsView with a round rectangle
};


//----------------------------------------------------------------------------------------
// AdornerElement
//----------------------------------------------------------------------------------------

struct AdornerElement
{
    AdornPriority    priority;
    TAdorner*         adorner;

    AdornerElement(AdornPriority itsPriority, TAdorner* itsAdorner);
        // Constructor
};

typedef AdornerElement* AdornerElementPtr;


//----------------------------------------------------------------------------------------
// AdornerElement inline function definitions.
//----------------------------------------------------------------------------------------

inline AdornerElement::AdornerElement(AdornPriority itsPriority,
                                     TAdorner*     itsAdorner)
{
    priority = itsPriority;
    adorner = itsAdorner;
}


//----------------------------------------------------------------------------------------
// TAdornerList: A list for keeping TAdorner objects ordered by priority
//----------------------------------------------------------------------------------------

class TAdornerList : public TSortedDynamicArray
{
    MA_DECLARE_CLASS;

public:
    inline TAdornerList()
    { }

    virtual ~TAdornerList();
        // Destructor

    inline void IAdornerList()
    { ISortedDynamicArray(0,sizeof(AdornerElement)); }
        // Initialize the AdornerList procedurally.

    //------------------------------------------------------------------------------------
    // Stream I/O protocol support.
    //------------------------------------------------------------------------------------

    virtual void ReadFrom(TStream* aStream);    // Override

    virtual void WriteTo(TStream* aStream);    // Override


    virtual CompareResult CompareElements(void* Element1, void* Element2);    // Override
        // Compares Two TAdorner objects based on their priority

    void AddAdorner(TAdorner* itsAdorner, AdornPriority itsPriority);
        // Add the adorner to the list

    inline TAdorner* AdornerAt(ArrayIndex index) const
    { return ((AdornerElementPtr) ComputeAddress(index))->adorner; }

    inline AdornPriority PriorityAt(ArrayIndex index) const
    { return ((AdornerElementPtr) ComputeAddress(index))->priority; }
        // Return the priority stored in the element record associated with this
        // adorner.  Used when cloning a list of adorners.

};

//----------------------------------------------------------------------------------------
// Global function declarations
//----------------------------------------------------------------------------------------

extern void InitUAdorners();

extern TAdorner* NewStdAdorner(IDType signature,
                                      const ClassName& className,
                                      IDType itsID,
                                      Boolean freeOnDeletion);


//----------------------------------------------------------------------------------------
// Global, preallocated, shared adorners:
//----------------------------------------------------------------------------------------

extern TDimAdorner* gDimAdorner;                // Calls the view's Dim method

extern TDrawAdorner* gDrawAdorner;                // Calls the view's Draw method

extern TEraseAdorner* gEraseAdorner;            // Erases the area passed in the DoDraw
                                                // method

extern THiliteAdorner* gHiliteAdorner;            // Calls the view's Hilite method

extern TPrintAdorner* gPrintAdorner;            // Calls the view's DoDrawPrintFeedback
                                                // method

extern TResizeIconAdorner* gResizeIconAdorner;    // Calls the TWindow's DrawResizeIcon
                                                // method

extern TSelectionAdorner* gSelectionAdorner;    // Calls the view's DoHighlightSelection
                                                // method


//----------------------------------------------------------------------------------------
// Convenient RGB color settings
//----------------------------------------------------------------------------------------

extern CRGBColor gRGBVeryLtGray;                // Greyscale very light gray

extern CRGBColor gRGBLtGray;                    // Greyscale light gray

extern CRGBColor gRGBGray;                        // Greyscale regular gray

extern CRGBColor gRGBDkGray;                    // Greyscale dark gray

#endif